[DX-2353] docs: clarify max_record_size and omit_detailed_recording do not apply to aggregate pumps - #2800

This pull request is a documentation update that clarifies the behavior of two configuration settings, max_record_size and omit_detailed_recording, for Tyk's aggregate pumps (mongoaggregate and sqlaggregate). It adds an explicit note explaining that these settings have no effect on aggregate pumps because their data does not include the raw_request or raw_response payloads that these settings are designed to manage.

Files Changed Analysis

• File Modified: snippets/pump-config.mdx
• Changes: 12 lines added, 0 deleted.
• Summary: The change consists of adding the same explanatory note to four sections within the Tyk Pump configuration documentation. The note is applied to both the omit_detailed_recording and max_record_size settings for the mongoaggregate and sqlaggregate pump types.

Architecture & Impact Assessment

• What this PR accomplishes: It corrects the documentation to prevent users from misconfiguring aggregate pumps under the false assumption that these settings will control record size. This aligns the documentation with the actual system behavior, reducing potential support issues and user confusion.
• Key technical changes introduced: This is a documentation-only change. No application code or system behavior is altered.
• Affected system components: The only component affected is the Tyk Pump configuration documentation. There is no impact on the runtime of Tyk Pump or any other part of the Tyk stack.

flowchart TD
    subgraph Tyk Pump Documentation
        A["pump-config.mdx"] -- Documents --> B & C
    end

    subgraph Configuration Settings
        B["pumps.mongoaggregate.*"]
        C["pumps.sqlaggregate.*"]
    end

    subgraph Clarification Added
        D["Note: omit_detailed_recording has no effect"]
        E["Note: max_record_size has no effect"]
    end

    B --> D & E
    C --> D & E

Scope Discovery & Context Expansion

• The scope of this PR is narrowly focused on a single documentation file.
• The PR description provides crucial context: snippets/pump-config.mdx is an auto-generated file. This manual edit is a short-term fix to get the correction published quickly.
• The long-term, durable fix is being implemented in the source repository in pull request tyk-pump#1090. This ensures that when the documentation is next regenerated, the clarification will be preserved, preventing any configuration drift.

Powered by Visor from Probelabs

Last updated: 2026-08-31T11:59:58.410Z | Triggered by: pr_updated | Commit: d1fd4a5

💡 TIP: You can chat with Visor using /visor ask <your question>

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

✅ Technical-accuracy Check Passed

No technical-accuracy issues found – changes LGTM.

✅ Security Check Passed

No security issues found – changes LGTM.

✅ Technical-accuracy Check Passed

No technical-accuracy issues found – changes LGTM.

✅ Security Check Passed

No security issues found – changes LGTM.

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

✅ Quality Check Passed

No quality issues found – changes LGTM.

Powered by Visor from Probelabs

Last updated: 2026-08-31T11:59:40.625Z | Triggered by: pr_updated | Commit: d1fd4a5

💡 TIP: You can chat with Visor using /visor ask <your question>

PR Code Suggestions ✨

No code suggestions found for the PR.

STE100 style check (advisory)

1 errors, 6 warnings across 1 file(s).

warning[passive-voice]: possible passive voice "are pulled"
 --> snippets/pump-config.mdx:6:28
  |
6 | analytics records in Redis are pulled. If it's set, `storage_expiration_time` is used to
  |                            ^^^^^^^^^^
  = help: rewrite in the active voice: name the actor before the verb
warning[passive-voice]: possible passive voice "is used"
 --> snippets/pump-config.mdx:6:79
  |
6 | analytics records in Redis are pulled. If it's set, `storage_expiration_time` is used to
  |                                                                               ^^^^^^^
  = help: rewrite in the active voice: name the actor before the verb
warning[passive-voice]: possible passive voice "is enabled"
 --> snippets/pump-config.mdx:13:85
   |
13 | The number of seconds for the analytics records TTL. It only works if `purge_chunk` is
   |                                                                                     ^^
   = help: rewrite in the active voice: name the actor before the verb
warning[ing-form]: "connection_string" uses the -ing form
 --> snippets/pump-config.mdx:37:5
   |
37 |     "connection_string": "host=sql_host port=sql_port user=sql_usr dbname=dbname password=sql_pw",
   |     ^^^^^^^^^^^^^^^^^
   = help: use the infinitive or an approved form
warning[ing-form]: "table_sharding" uses the -ing form
 --> snippets/pump-config.mdx:38:5
   |
38 |     "table_sharding": false
   |     ^^^^^^^^^^^^^^
   = help: use the infinitive or an approved form
error[sentence-length]: descriptive sentence has 28 words; the limit is 25
 --> snippets/pump-config.mdx:638:1
    |
638 | "dogstatsd": {
    | ^^^^^^^^^^^^^^
    = help: split the sentence into shorter sentences
warning[ing-form]: "initializing" uses the -ing form
 --> snippets/pump-config.mdx:665:36
    |
665 | [May 10 15:23:44]  INFO dogstatsd: initializing pump
    |                                    ^^^^^^^^^^^^
    = help: use the infinitive or an approved form

Advisory only, this does not block merging. Run python3 scripts/ste_check.py locally to check before pushing.